Skip to content

Prepublish updates - #20

Merged
jasir-serpapi merged 7 commits into
mainfrom
jasir/prepublish-updates
Nov 2, 2026
Merged

jasir-serpapi merged 7 commits into
mainfrom
jasir/prepublish-updates

Conversation

@jasir-serpapi

@jasir-serpapi jasir-serpapi commented Nov 2, 2026 •

Copy link
Copy Markdown
Collaborator

Prepare nokodown for open-sourcing and RubyGems 0.1.0:

  • the README installs from RubyGems,
  • NOTICE adds Readability's full notice, and the gemspec gets metadata, and nokolexbor ~> 0.6,
  • add a CHANGELOG.
  • Removes the Extract API integration notes and SerpApi specific details ("Current Extract rule" is now "Main-region baseline", same numbers)
  • add the SerpApi logo and an Extract API link.
  • Adds Ruby 4.0 to CI and fixes its two warnings; specs pass on Ruby 2.7, 3.4 and 4.0.

The README pointed at the private repository over SSH. It now installs
the published gem, and says that a plain gem install on Ruby 2.7 or 3.0
needs nokolexbor 0.6.4 first: RubyGems picks nokolexbor 0.8, which needs
Ruby 3.1, while Bundler resolves to 0.6.4 on its own.

Only Nokodown.extract, Nokodown.to_markdown and Nokodown::Result are
public; the other classes can change in any release.
Apache-2.0 section 4(d) requires a derivative work to include the
attribution notices from its source's NOTICE file. Readability's lists
Mozilla and Contributors as well as Arc90, and ours had only Arc90.
nokolexbor is limited to 0.x, so a 1.0 with breaking changes is not
picked up, and gem build no longer warns about an open-ended
dependency. The gem links its source, changelog and issues on
RubyGems, and pushing a release needs MFA. CHANGELOG.md starts with
0.1.0 and ships in the gem.
The README described how to wire the gem into the Extract API and
benchmarked the API's current rule by name. The integration notes
belong with that change, not in a public README, and the baseline is
now named for what it does: convert the page's <main>, else its only
<article>, else <body>, without main-content detection. Its scores are
unchanged; run_nokodown.rb takes "baseline" instead of "current".

Comments that described SerpApi's production Ruby and nokolexbor
versions now say why CI tests them.
Some test pages were studied while tuning nokodown, and 139 of the 511
have the same HTML as a development page, so the test scores are not a
blind result. The README now says so.
Ruby 4.0 warns that the CGI library is gone; cgi/escape has
CGI.unescapeHTML on every Ruby from 2.7. From 3.4 URI::DEFAULT_PARSER
is the RFC 3986 parser, whose unescape is obsolete, so the resolver
uses the RFC 2396 parser where it exists. Both warnings showed only
with -W. The specs pass without warnings on Ruby 2.7, 3.4 and 4.0.
The README opens with the SerpApi logo from the media kit, using the
gradient version, which reads on GitHub's light and dark themes. A
note under the intro links the Extract API for readers who would
rather not fetch pages themselves.
@jasir-serpapi
jasir-serpapi merged commit 8937629 into main Nov 2, 2026
4 checks passed
@jasir-serpapi
jasir-serpapi deleted the jasir/prepublish-updates branch November 2, 2026 21:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant